home *** CD-ROM | disk | FTP | other *** search
/ Acorn User: China / Acorn User China CD-ROM (UK) (Disc A) / Acorn User China CD-ROM (UK) (Disc A).bin / DEMON / DEVELOPER / AUUE.ARC / !AutoUUE_!Help < prev    next >
Encoding:
Text File  |  1995-09-03  |  8.8 KB  |  235 lines
  1.                 !AutoUUE
  2.                 --------
  3. v0.11 (28-Aug-95)
  4.  
  5.                                    © J.Beech 1995
  6.  
  7. Contents
  8. --------
  9.  
  10.    1)    Notes
  11.    2)    Loading Instructions
  12.    3)    The Configuration Window
  13.    4)    DeUUCoding a Mail Packet
  14.    5)    Understanding the Output Format
  15.    6)    Running automatically with Newsbase
  16.    7)    Future versions/developments (read:BUGS)
  17.    8)    History
  18.    9)    Contacting Me
  19.  
  20. Notes
  21. -----
  22.  
  23. (If you are reading this in !Edit, use Expand Tabs to turn the [09]'s into
  24. something useful)
  25.  
  26. Note:    Don't try running !AutoUUE from an Archive, CFS or a Floppy Disc!!!
  27.     It really needs a fast harddisc as it does a *lot* of HDThrashing
  28.  
  29. Warning:I have been unable to test this version on any version of RISC OS
  30.     previous to 3.6 ... please write to me with feedback so I can
  31.     correct any bugs. Having said that, it should work on RO3.0 upwards
  32.     **But will not work on Risc OS 2!!**-Upgrade NOW
  33.  
  34. Loading
  35. -------
  36.   C'mon mate....refer to the welcome guide. Double click it, and it's loaded.
  37.   It *does* need quite a bit of memory though. (At least, it does if you have
  38.   a 1Mb machine)
  39.   
  40. Config Window
  41. -------------
  42.   • Junk messages under 'xx' lines
  43.       When selected, this will find any messages that have less than the
  44.       number of lines you specify (default 5) and remove them from your
  45.       mail file. It stores them in a seperate file called 'Junk' (Just
  46.       in case there might be something you need in there!)
  47.       After decoding, the file called junk should be quickly browsed, then
  48.       deleted. (It's probably going to be full of 'This is a test' messages.
  49.   • Delete source mail folder
  50.       *Dangerous* When !AutoUUE has finished with decoding and sorting your
  51.       mail, it will delete the file you dragged to the iconbar, and replace
  52.       it automatically with your processed mail file!!
  53.       !Only select this one if you know what your doing!
  54.   • Keep a log of decisions
  55.       This is very useful to me, but probably not anyone else. It shows
  56.       how each message is delt with, and lists at the end any messages
  57.       that my coding has failed to decipher. Probably not worth selecting.
  58.   • Include unknown binaries in mail
  59.       If selected, anything !AutoUUE does not understand will be put back
  60.       in with the mail, so you can UUDecode it by hand from TTFN or Offlite,
  61.       etc.
  62.       When unselected, it will create another file in the Out directory, and
  63.       move them into there. They will (or at least, attempt to be) decoded 
  64.       along with the other binaries.
  65.       
  66. DeUUCoding a mail packet
  67. ------------------------
  68.   Easy. Drag it to the !AutoUUE Icon.
  69.   
  70. Understanding the output format
  71. -------------------------------
  72.  
  73.   OK, by popular request, I've had to write this bit...
  74.   
  75.   After looking at your news, AutoUUE opens up a directory on the desktop
  76. that's full of text files and directories. I will try to explain what each
  77. one is and what it holds.
  78.  
  79.   • Directories '1','2',etc
  80.   All the text files in these directories are decoded binaries that just need
  81. to be SetTyped. (Programs like GuessType are good for this)
  82. Move all these out to relevant places, if you want to keep them.
  83.   
  84.   • Text file 'Junk'
  85.   All the messages that you specified to be 'junked' on the config window
  86. will be placed in here. This file may not necessarily be here, depending on
  87. what choices you have set.
  88.  
  89.   • Directory 'Junk1'
  90.   This will be here if the Junk Text file exists. If AutoUUE missed any
  91. binaries, then they would be decoded into this directory. You will probably
  92. never find anything in here (I haven't) but it's better to be safe than
  93. sorry.
  94.  
  95.   • Text file 'Log'
  96.   A text file that holds the details of decisions made in the decoding
  97. process. This probably isn't of interest to you, but I find it useful for
  98. finding out what binaries !AutoUUE can't detect yet.
  99.  
  100.   • Text file 'News'
  101.   This may or may not be in this directory. If it isn't, then it has been
  102. written over the top of the file you dragged to !AutoUUE. If you didn't want
  103. this, then see the Configuration section.
  104.   News contains all the normal messages (non binaries) from the processed
  105. file. These can now be transferred to your mail reader and read as per
  106. normal.
  107.  
  108.   • Directory called 'News1'
  109.   As per Junk1: better safe than sorry
  110.   
  111.   • Text file 'Other'
  112.   Contains all the posts that !AutoUUE did not understand in the slightest.
  113. If this file doesn't exist, check your configuration, as it might be adding
  114. these in with your mail.
  115.   
  116.   • Directory 'Other1'
  117.   Probably going to contain a mix of Good binaries and trashed ones. If
  118. 'Other' does not exist, then these will probably be found in the 'News1'
  119. directory.
  120.  
  121.   • File 'Pending'
  122.   Have you ever got parts 1/4, 2/4, 3/4 of a binary post and not part 4/4??
  123. If !AutoUUE comes across posts like these, it moves them into the file
  124. Pending and doesn't try to decode them. As you use AUUE, this file will grow
  125. quite large. At times, it is worth moving it outside !AutoUUE (you cannot
  126. decode it from inside) and processing it again to see if there are any files
  127. in there with all the parts
  128.  
  129.   • [removed] Directory 'Pend1'
  130.   (You should no longer get this directory)
  131.   This directory contains the attempted decoding of all the incomplete
  132. binaries. During testing, I estimate that about 1 in 20 of these binaries was
  133. not corrupted. It is probably not worth checking this directory, but just
  134. wiping it and processing the Pending file.
  135.  
  136.   • Exec file called 'Wipe'
  137.   **WARNING** This will wipe all binaries, Dirs and News with the exception
  138. of the Pending text file. (It's an easy way to tidy up AUUE after a decode)
  139.  
  140. Running automatically with Newsbase
  141. -----------------------------------
  142.  
  143.     !AutoUUE has the facility to work alongside !Newsbase and !TTFN, if
  144. you use those newsreaders. This is slightly more complex to install, but is
  145. helpful with news debatching, and it takes a few steps of the process out of
  146. the way.
  147.  
  148.     To install:
  149. • Copy !AutoUUE to a directory where it will be 'seen' by the filer before
  150. NewsBase is loaded.
  151.  
  152. • Select the 'Delete source mail folder' in the choices menu on !AutoUUE, and
  153. save. (This is vital, but the other options are up to your preferences)
  154.  
  155. • Open the directory !Newsbase.Transports. whatever transport you
  156. use (probably ka9q, if you use !TCPIP, or termite if you use !Termite)
  157.  
  158. • Load the file 'prefetch' into !Edit, or create an obey file called
  159. 'prefetch' if one does not exist
  160.  
  161. • Add to the bottom of the file the following line:
  162. If "<AutoUUE$Dir>" <> "" Then Run <AutoUUE$Dir>.!Run <params>
  163.  
  164. The parameters are:
  165. -q (OPTIONAL) if you want AUUE to quit when it has finished processing
  166. -c (OPTIONAL) if you want to confirm decoding of each batch
  167. -f (REQUIRED) followed by the filename of the newsfile
  168.  
  169. Eg: (Termite)
  170. If "<AutoUUE$Dir>" <> "" Then Run <AutoUUE$Dir>.!Run -q -c -f <Termite$MailBox>.InTray.Internet.News
  171.  
  172. Eg: (!TCPIP)
  173. If "<AutoUUE$Dir>" <> "" Then Run <AutoUUE$Dir>.!Run -f <Mail$Dir>.folder.DemNews
  174.  
  175. Now save the file
  176.  
  177. • Load the text file 'params' into edit (from the transports.xxx directory)
  178. If there is a line saying 'prefetch <number> prefetch' then the file does
  179. not need editing.
  180. If the above line does not exist, then create it using 0 as the number.
  181.  
  182. OK...you should now be ready to go. Download some news, and load !Newsbase.
  183. !AutoUUE should debatch it before it reaches !TTFN without you having to
  184. drag your news file to it manually. (Fingers crossed)
  185.  
  186. Future versions
  187. ---------------
  188.  
  189.     Stop AUUE from thinking the c.s.a FAQ is a multi-part binary!!!
  190.     Multi-parts using following methods:
  191.       (part 1 of 3) --the part bit
  192.       (0-1) --using - instead of /
  193.  
  194.     I've run out of Ideas! Write to me and tell me what you want adding:
  195. I'll be overjoyed to get some feedback. I currently have *BUGGER ALL*, so
  196. what is implemented is what I want put in. **MAIL ME**
  197.  
  198. History
  199. -------
  200.    v0.01 Test run to see if it was possible
  201.    v0.02 First alpha-release (speed increase)
  202.    v0.03 Better handling of multi-part files
  203.    
  204.    v0.10 <Rewrite> Proper front end,(slight speed increase)
  205.          Higher understanding, and it does not drop any (well posted)
  206.          binaries that could be decoded by hand with a newsreader
  207.          NB: (That it is coded to search for!)
  208.    
  209.    v0.11 Handles more than 1000 messages in a friendly way now
  210.          Tidied up output files somewhat
  211.          When delete option set, it now writes News over the top of the
  212.           source file
  213.           
  214.    v0.12 Format fully tidied up (as far as it will be)
  215.          Rudimentary support for auto-debatching in newsbase
  216.          Now manages more badly posted messages:
  217.          -- "LABLUE3.MID part 1/3" can now be understood.
  218.          -- (Part/Total at end, without brackets)
  219.          
  220.  
  221. Contacting me
  222. -------------
  223.  **Later versions may become shareware unless I receive lots of feedback**
  224. I can be emailed at:
  225.   saint@nutters.dircon.co.uk
  226.   Or the users 'Mdt' on Arcade
  227.              'James Beech' on Digibank
  228.  
  229.   James Beech
  230.   47 Brockswood Lane
  231.   Welwyn Garden City
  232.   Herts, AL8 7BE
  233.   
  234.   Tel: (01707) 335047
  235.